home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 May: Tool Chest / Dev.CD May 97 TC.toast / Sample Code / Snippets / Development Tools & Languages / Low Level Debugger macros / Definitions.h
Encoding:
Text File  |  1992-07-15  |  3.0 KB  |  110 lines  |  [TEXT/MPS ]
  1. //     Definitions.h
  2. //     Copyright ©1992 Apple Computer, Inc.
  3. //    Kent Sandvik DTS
  4. //    This file contains debugger macros
  5.  
  6. #ifndef __DEFINITIONS__
  7. #define __DEFINITIONS__
  8.  
  9.  
  10. /*     DEBUGGER FLAGS
  11.     MacApp 3.0 has many special flags which could be turned on/off from the
  12.     debug menu entry. We are mostly interested in signalling something from
  13.     the application to the source code, so we are interested to use:
  14.     
  15.     gIntenseDebugging - turn on intense debugging, it will also signal to the
  16.     framework to start tracing many other things, so it's very costly.
  17.     
  18.     gUserFlag1, gUserFlag2, gUserFlag3 - these are better suited for special control
  19.     that we know about. In this case we are using gUserFlag1.
  20.     
  21.     WHY DON'T YOU USE MACROS, INSTEAD OF INLINE FUNCTIONS?
  22.     Because I'm sick-n-tired of tracing macro based problems. It should not matter,
  23.     we are still inlining code directly instead of calling functions. Also, then
  24.     I'm able to use static variables for certain 'macros' which should only do something
  25.     based on earlier state.
  26.     
  27.     TMON USE
  28.     These macros are defined for MacsBug, i.e. they start with a ';' in the beginning
  29.     of the string. If you want to use TMON, change the ';' to a '™' and also change the debugger
  30.     statement to something suitable in the TMON world. BTW, these macros are based on
  31.     MacsBug 6.2.2.
  32.     
  33. */
  34.  
  35. //    Globals
  36.     Boolean gHeapScramble     = FALSE;        // heap scrambling
  37.     Boolean gLeaks             = FALSE;        // if Leaks DCMD is installed, test for memory leaks
  38.     
  39.     
  40. inline void DBOUTPUT(CStr255 a) //    Call debugger with a string - used for other macros.
  41. { 
  42.     if(gUserFlag1) DebugStr(a);
  43. }
  44.  
  45.  
  46. inline void DBHEAPCHECK()         //    Heap Check - check for heap status, it stops if something is wrong
  47. { 
  48.     DBOUTPUT(";HC; G");
  49. }
  50.  
  51. inline void DBHEAPCHECKLOG()     //    Heap Check variation - log information inside a log file
  52. {
  53.     DBOUTPUT("Extended Heap Check:; LOG HeapTest; WH; HC; HZ; LOG; G"); 
  54. }
  55.  
  56.  
  57. inline void DBHEAPSCRAMBLEON()     //    Turn on Heap Scramble
  58. { 
  59.     if (!gHeapScramble){
  60.         DBOUTPUT("Heap Scramble ON; HS; G");
  61.         gHeapScramble = TRUE;
  62.     }
  63. }
  64.  
  65.  
  66. inline void DBHEAPSCRAMBLEOFF() //    Turn off Heap Scramble
  67. { 
  68.     if(gHeapScramble){
  69.         DBOUTPUT("Heap Scramble OFF; HS; G");
  70.         gHeapScramble = FALSE;
  71.     }
  72. }
  73.  
  74.  
  75. inline void DBHEAPINFOLOG()        //    Log Heap information into log
  76. {
  77.     DBOUTPUT("Heap Info:; LOG HeapInfo; WH; HT; HD RS; LOG; G"); 
  78. }
  79.  
  80.  
  81. inline void DBEVENTRECORDLOG()     // Log Event Records at particular instanced
  82. {
  83.     DBOUTPUT("Event Record:; LOG EventRecordLog; WH; DM 000234C4 EventRecord; LOG; G");
  84. }
  85.  
  86.  
  87. inline void DBLEAKSON()     //    Turn on Leaks dcmd (assume we have it installed, if not it's on Developer CD)
  88. { 
  89.     if (!gLeaks){
  90.         DBOUTPUT("Leaks ON; Leaks On; G");
  91.         gLeaks = TRUE;
  92.     }
  93. }
  94.  
  95.  
  96. inline void DBLEAKSOFF()     //    Turn off Leaks dcmd
  97. { 
  98.     if(gLeaks){
  99.         DBOUTPUT("Leaks OFF; Leaks Off; G");
  100.         gLeaks = FALSE;
  101.     }
  102. }
  103.  
  104.  
  105. //… I think you got the idea now, feel free to create any other MacsBug/low level debugger
  106. //    commands which could be used from debug mode (or actually any other Macintosh source code
  107.     which could set a flag dynamically from a menu entry).
  108.  
  109.  
  110. #endif  __DEFINITIONS__